Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Packaged build artifacts into artifacts directory #242

Merged
merged 1 commit into from
Nov 12, 2020
Merged

Packaged build artifacts into artifacts directory #242

merged 1 commit into from
Nov 12, 2020

Conversation

Joshua-Anderson
Copy link
Contributor

Currently, fprime-util install installs files into a variety of different
locations, which makes it difficult to archive all the build artifacts.

Now, fprime-util install has been removed and fprime-util build
automatically ensures all build artifacts are installed into the location
provided by the install_dest settings option, which defaults to build-artifacts.

It has the following structure:

  • /bin: deployment binaries
  • /lib/static: deployment static libraries
  • /dict: command dictionary, autogenerated html command,
    channel, and event documentation

The GDS has also been updated to automatically use the settings.ini file to look
into the artifacts directory to find the deployment application and dictionary.

Resolves #236

@lgtm-com
Copy link

lgtm-com bot commented Nov 10, 2020

This pull request introduces 2 alerts when merging b5d9796 into 9bf02f0 - view on LGTM.com

new alerts:

  • 1 for Unused import
  • 1 for Module is imported with 'import' and 'import from'

@LeStarch
Copy link
Collaborator

@Joshua-Anderson you probably need to pull from devel now

@Joshua-Anderson Joshua-Anderson force-pushed the build_artifacts branch 6 times, most recently from 79f93ed to 9006782 Compare November 11, 2020 18:36
LeStarch
LeStarch reviewed Nov 11, 2020
View reviewed changes
Copy link
Collaborator

@LeStarch LeStarch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a bunch of comments.

Ref/README.md

```
cd fprime/Ref
fprime-gds -d .
fprime-gds
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why wouldn't you improve the documentation to run from the packaged output?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured fprime-gds was cleaner than fprime-gds -r build-artifacts. Since we added artifact root autodetection we might as well take advantage of it, right?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this fail because there is no settings.ini to tell it which artifact directory to use?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, because even if the settings.ini is missing it'll provide the default location build-artifacts.

Detection order: --root argument, else settings.ini, else build-artifacts.

Ref/README.md Show resolved Hide resolved
cmake/API.cmake Show resolved Hide resolved
cmake/API.cmake Show resolved Hide resolved
cmake/support/AC_Utils.cmake Show resolved Hide resolved
cmake/target/dict.cmake Show resolved Hide resolved
docs/Tutorials/GpsTutorial/Tutorial.md Show resolved Hide resolved
@LeStarch
Copy link
Collaborator

I ran this, works as expected.

@Joshua-Anderson
Packaged build artifacts into artifacts directory
20b5f29 
Currently, `fprime-util install` installs files into a variety of different
locations, which makes it difficult to archive all the build artifacts.

Now, `fprime-util install` has been removed and `fprime-util build`
automatically ensures all build artifacts are installed into the location
provided by the `install_dest` settings option, which defaults to `build-artifacts`.

It has the following structure:

- <PLATFORM>/bin: deployment binaries
- <PLATFORM>/lib/static: deployment static libraries
- <PLATFORM>/dict: command dictionary, autogenerated html command,
  channel, and event documentation

The GDS has also been updated to automatically use the settings.ini file to look
into the artifacts directory to find the deployment application and dictionary.
@Joshua-Anderson Joshua-Anderson merged commit 85cdb25 into nasa:devel Nov 12, 2020
@Joshua-Anderson Joshua-Anderson deleted the build_artifacts branch November 12, 2020 17:12
@Joshua-Anderson Joshua-Anderson mentioned this pull request Nov 13, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LeStarch LeStarch LeStarch approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

CMake Install and GDS Package
2 participants
@Joshua-Anderson @LeStarch